Skip to content

Conversation

@wbrennan899
Copy link
Collaborator

Summary

This PR enhances the documentation's internal linking structure and navigation, making it easier for users to find related content and navigate between topics. The changes focus on improving cross-references, adding visual card-based navigation, and consolidating content for better organization.

Key Changes

Improved Internal Linking

  • Added comprehensive cross-references throughout documentation pages
  • Replaced plain text references with proper markdown links to relevant sections
  • Ensured all mentions of features and concepts link to their respective documentation

Navigation Enhancements

  • Added CardGroup navigation elements to key overview pages for visual topic browsing
  • Implemented "Next Steps" sections with card-based navigation for related topics
  • Enhanced the main index page with organized card groups for common tasks

Content Reorganization

  • Moved permissions-and-authorization.mdx from /cli to /api-reference for better logical grouping
  • Removed redundant redirect from docs.json
  • Consolidated CLI get-started page to be more focused

Terminology Clarification

  • Addressed "Cloud Sync" vs "Cloud Copy" terminology inconsistency
  • Added clarifying note explaining that both the GUI "Cloud Copy" button and CLI vastai cloud copy command refer to the same Cloud Sync feature

Template Documentation Updates

  • Added Docker execution environment information to templates introduction
  • Improved template linking throughout instance documentation
  • Enhanced template-related navigation cards

Content Cleanup

  • Removed duplicate warning about copying to /root in data movement documentation
  • Fixed whitespace and formatting issues in multiple files
  • Cleaned up CLI get-started page for better clarity

Files Modified

  • Navigation & Structure: docs.json - Updated navigation structure and removed obsolete redirect
  • API Reference: Moved and renamed permissions-and-authorization.mdx to api-reference directory
  • Getting Started: Enhanced index.mdx and quickstart.mdx with comprehensive card-based navigation
  • Instances Documentation: Updated linking in overview, choosing, connection, management, and storage sections
  • Templates: Improved introduction.mdx with Docker execution environment details and better linking
  • Teams: Minor link updates in teams-quickstart.mdx and teams-roles.mdx
  • CLI: Simplified get-started.mdx with clearer messaging

@zubyjaved
Copy link
Contributor

One merge conflict, otherwise looks good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants